/**
 *    Copyright ${license.git.copyrightYears} the original author or authors.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package org.apache.ibatis.reflection.wrapper;

import java.util.List;

import org.apache.ibatis.reflection.MetaObject;
import org.apache.ibatis.reflection.factory.ObjectFactory;
import org.apache.ibatis.reflection.property.PropertyTokenizer;

/**
 * @author Clinton Begin
 * MyBatis 对对象级别的元信息的处理
 * 通过实现这个接口，可以判断当object是特定类型时，返回true，然后在下面的getWrapperFor中返回一个可以处理key为驼峰的ObjectWrapper 实现类即可。
 * ObjectWrapper类可以说是对象反射信息的facade模式，
 *
 * 当然，我们不需要从头实现ObjectWrapper接口,可以选择继承BeanWrapper或者MapWrapper。
 * 比如对于Map类型，我们可以继承MapWrapper，让参数useCamelCaseMapping起作用。MapWrapper默认的findProperty方法并没有做驼峰转换处理，
 */
public interface ObjectWrapper {

  /**
   * 如采 ObjectWrapper 中封装的是普通的 Bean 对象，则 调用相应属性的相应 getter 方法，
   * 如采封装的是集合类，则获取指定 key 或下标对应的 value 值
   * @param prop
   * @return
   */
  Object get(PropertyTokenizer prop);

  /**
   * 如果 ObjectWrapper 中封装的是普通的 Bean 对象 则调用相应属性的相应 setter 方法
   * 如果封装的是集合类，则设置指定 key 或下标对应的 value
   * @param prop
   * @param value
   */
  void set(PropertyTokenizer prop, Object value);

  /**
   * 查找属性表达式指定的属性，第二个参数表示是否忽略属性表达式中的 画线
   * @param name
   * @param useCamelCaseMapping
   * @return
   */
  String findProperty(String name, boolean useCamelCaseMapping);

  /**
   * 查找可写属性的名称集合
   * @return
   */
  String[] getGetterNames();

  /**
   * 查找可读属性的名称集合
   * @return
   */
  String[] getSetterNames();

  /**
   * 解析属性表达式指定属性的 setter 方法的参数类型
   * @param name
   * @return
   */
  Class<?> getSetterType(String name);

  /**
   * 解析属性表达式指定属性的 getter 方法的返回值类型
   * @param name
   * @return
   */
  Class<?> getGetterType(String name);

  boolean hasSetter(String name);

  boolean hasGetter(String name);

  /**
   * 为属性表达式指定的属性创建相 metaObject 对象
   * @param name
   * @param prop
   * @param objectFactory
   * @return
   */
  MetaObject instantiatePropertyValue(String name, PropertyTokenizer prop, ObjectFactory objectFactory);

  /**
   * 封装的对象是否为 collection 类型
   * @return
   */
  boolean isCollection();

  /**
   * 调用 Collection 对象的 add 方法
   * @param element
   */
  void add(Object element);

  /**
   * 调用 Collection 对象 addAll 方法
   * @param element
   * @param <E>
   */
  <E> void addAll(List<E> element);

}
